﻿
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- saved from url=(0014)about:internet -->
<html xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:mssdk="winsdk" xmlns:script="urn:script" xmlns:build="urn:build" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="Description" content="Using Symbols"/>
<meta name="MSHAttr" content="PreferredSiteName:MSDN"/>
<meta name="MSHAttr" content="PreferredLib:/library/windows/hardware"/>
<title>Using Symbols</title>

<meta name="MS-HAID" content="Engine_DG_0ca00a05-8220-465b-aea6-76811384d300.xml"/>


<link rel="STYLESHEET" type="text/css" HREF="../common/backsdk4.css"/>





<style>
html,div { margin: 0; padding: 0;}

body {
	padding: 0px;
	margin: 0px;
	overflow: auto;
	height: 100%;
}

#winchm_template_button{
	float: right;
	width: 93px;
	top: 7px;
	position: relative;
	text-align: right;
	right: 5px;
	height: auto;
}

#winchm_template_top{
	padding: 0px;
	margin: 0px;
	border-bottom: 1px solid #9B9B9B;
	background-color: #B1CEFE;
}

#winchm_template_navigation{
	margin: 0px;
	padding-top: 7px;
	padding-left: 7px;
	padding-bottom: 3px;
	padding-right: 0px;
	font-size: 8.5pt;
	font-family: Arial, Helvetica, sans-serif;
	font-weight: normal;
	color: #585858;
}

#winchm_template_title{
	margin: 0px;
	padding-top: 4px;
	padding-left: 7px;
	padding-bottom: 7px;
	padding-right: 0px;
	font-size: 18px; 
	font-family: Verdana, Geneva, sans-serif;
	color: #363636;
}

#winchm_template_content{
	margin-top: 20px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	width: auto  !important;
	width: 100%;
}

#winchm_template_footer{
	border-width: 1px;
	border-color: #B1CEFE;
	border-top-style: solid;
	margin-top: 15px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	padding-top: 7px;
	padding-left: 0px;
	padding-bottom: 0px;
	padding-right: 0px;
	font-family: arial, helvetica, sans-serif;
	font-size: 8.5pt;
	color: #696969;
	width: auto;
	text-align: left;
}


#winchm_template_container{
	margin: 0px;
	padding: 0px;
	position: static;
	padding-bottom: 3px;
	overflow: auto;
	background-color: #FFFFFF;
}


@media print
{
#winchm_template_container{
	position: static;	
	margin: 0px;
	padding: 5px;
	
	width: auto;
	height: auto;
	overflow: auto;
}
#winchm_template_button{
visibility:hidden;
}
}

#winchm_template_navigation A:link	{text-decoration: none; color:#004080}
#winchm_template_navigation A:visited  {text-decoration: none; color: #004080}
#winchm_template_navigation A:active {text-decoration: none; color: #004080 }
#winchm_template_navigation A:hover {text-decoration: none;color: #0080FF}

A:link	{text-decoration: underline; color:#0033CC}
A:visited  {text-decoration: underline; color: #0033CC}
A:active {text-decoration: underline; color: #0033CC }
A:hover {text-decoration: underline;color: #FF0000;}
</style>
<script type="text/javascript">
function isMobile(){
Agent = window.navigator.userAgent;
if (Agent.indexOf("iPhone")>=1 || Agent.indexOf("iPad")>=1 || Agent.indexOf("iPod")>=1 || Agent.indexOf("Android")>=1){
return true;
}else{
return false;	
}

}
function d_onresize(){
if (window.navigator.userAgent.indexOf("MSIE")>=1){
document.getElementById('winchm_template_container').style.pixelWidth = document.body.offsetWidth - 3;
document.getElementById('winchm_template_container').style.pixelHeight = document.body.offsetHeight - document.getElementById('winchm_template_top').offsetHeight - 4;
}
document.getElementById('winchm_template_container').style.top = document.getElementById('winchm_template_top').offsetHeight + 'px';
}

function d_onbeforeprint(){
document.getElementById('winchm_template_container').style.width = 'auto';
document.getElementById('winchm_template_container').style.height = 'auto';
}

function d_onafterprint(){
d_onresize();
}

if(!isMobile()){

window.onload = d_onresize;
window.onresize = d_onresize;
window.onbeforeprint = d_onbeforeprint;
window.onafterprint = d_onafterprint;

document.write("<style>\n");
document.write("body {overflow: hidden;}\n");
document.write("#winchm_template_container {position: absolute;overflow: auto;top : 0px;right: 0px;bottom: 0px;left: 0px;}\n");
document.write("</style>\n");
}

</script>
</head>
<body><script language="JavaScript" type="text/JavaScript">
function syn(){
if(parent.nav.tree){
 if(parent.nav.tree.loaded){
  parent.nav.tree.selectNode(222);
 }else{
  setTimeout("syn()",500);
}
  }else{
  setTimeout("syn()",500);
  }}
if(parent!=self){
  setTimeout("syn()",100);
}else{
  parent.location.href = "../../index.htm?page=debugger/using_symbols.htm";
}
originalOnload = window.onload;
if(originalOnload==null){
window.onload = function(){parent.contentLoaded = true;};
}else{
window.onload = function(){originalOnload();parent.contentLoaded = true;};
}
</script> 


<div id="winchm_template_top">
	<div id="winchm_template_button"><A href="controlling_threads_and_processes.htm" title="Previous topic"><img id="winchm_template_prev" alt="Previous topic" src="../template2/btn_prev_n.gif" border="0"></a><A href="modules.htm" title="Next topic"><img id="winchm_template_next" alt="Next topic" src="../template2/btn_next_n.gif" border="0"></a></div>
	<div id="winchm_template_navigation">Help &gt; 
<A href="introduction6.htm">Debugging Tools for Windows (WinDbg, KD, CDB, NTSD)</A> &gt; <A href="debugging_resources.htm">Debugging Resources</A> &gt; <A href="debugger_engine_and_extension_apis.htm">Debugger Engine and Extension APIs</A> &gt; <A href="using_the_debugger_engine_api.htm">Using the Debugger Engine API</A> &gt; <A href="debugger_engine_api_overview.htm">Debugger Engine API Overview</A> &gt; </div>
	<div id="winchm_template_title">Using Symbols</div>
</div>
<div id="winchm_template_container">
	<div id="winchm_template_content"><div id="mainSection"><p>For an overview of symbols, including using symbol files and symbol servers, see <a href="#Bookmark1494">Symbols</a>.</p>
<h3><a id="symbol_names_and_locations"></a><a id="SYMBOL_NAMES_AND_LOCATIONS"></a>Symbol Names and Locations</h3>
<p>To find the location of a symbol given its name, use <a href="#Bookmark645"><b>GetOffsetByName</b></a>.  For details on the syntax used to specify symbol names, see <a href="#Bookmark1531">Symbol Syntax and Symbol Matching</a>.</p>
<p>If the exact name of a symbol is not known, or multiple symbols have the same name, <a href="#Bookmark671"><b>StartSymbolMatch</b></a> will begin a search for symbols whose names match a given pattern.  For details on the syntax, see <a href="#Bookmark1923">String Wildcard Syntax</a>.</p>
<p>To find the name of a symbol given its location, use <a href="#Bookmark640"><b>GetNameByOffset</b></a>.  To find the names of symbols in a module near a given location, use <a href="#Bookmark641"><b>GetNearNamebyOffset</b></a>.</p>
<div class="alert"><b>Note</b>    Whenever possible, qualify the symbol with the module name -- for example <b>mymodule!main</b>.  Otherwise, if the symbol does not exist (for example, because of a typographical error) the engine will have to load and search the symbols for every module; this can be a slow process, especially for kernel-mode debugging.  If the symbol name was qualified with a module name, the engine will only need to search the symbols for that module.</div>
<div> </div>
<p>A symbol is uniquely identified using the structure <a href="#Bookmark889"><b>DEBUG_MODULE_AND_ID</b></a>.  This structure is returned by the methods <a href="#Bookmark719"><b>GetSymbolEntriesByName</b></a> and <a href="#Bookmark721"><b>GetSymbolEntriesByOffset</b></a>, which search for symbols based on their name and location, respectively.</p>
<p>The method <a href="#Bookmark722"><b>GetSymbolEntryInformation</b></a> returns a description of a symbol using the <a href="#Bookmark900"><b>DEBUG_SYMBOL_ENTRY</b></a> structure.</p>
<p>To find the offset of a field within a structure, use <a href="#Bookmark1120"><b>GetFieldOffset</b></a>.  To find the name of a field given its index within a structure, use <a href="#Bookmark677"><b>GetFieldName</b></a>.  To find the name of an enumeration constant given its value, use <a href="#Bookmark676"><b>GetConstantName</b></a>.</p>
<p>The method <a href="#Bookmark249"><b>GetSymbolInformation</b></a> can perform several requests for information about symbols.</p>
<h3><a id="symbol_options"></a><a id="SYMBOL_OPTIONS"></a>Symbol Options</h3>
<p>A number of options control how the symbols are loaded and unloaded.  For a description of these options, see <a href="#Bookmark1532">Setting Symbol Options</a>.  </p>
<p>Symbol options may be turned on by using <a href="#Bookmark625"><b>AddSymbolOptions</b></a>, and turned off by using <a href="#Bookmark664"><b>RemoveSymbolOptions</b></a>.</p>
<p><a href="#Bookmark653"><b>GetSymbolOptions</b></a> returns the current symbol options.  To set all the symbol options at once, use <a href="#Bookmark669"><b>SetSymbolOptions</b></a>.</p>
<h3><a id="reloading_symbols"></a><a id="RELOADING_SYMBOLS"></a>Reloading Symbols</h3>
<p>After loading symbol files, the engine stores the symbol information in an internal cache.  To flush this cache, use <a href="#Bookmark663"><b>Reload</b></a>. These symbols will have to be loaded again now or at a later time.</p>
<h3><a id="synthetic_symbols"></a><a id="SYNTHETIC_SYMBOLS"></a>
      Synthetic Symbols</h3>
<p><i>Synthetic symbols</i> are a way to label an arbitrary address for easy reference.  Synthetic symbols can be created in any existing module.  The method <a href="#Bookmark686"><b>AddSyntheticSymbol</b></a> creates a new synthetic symbol.  Synthetic symbols can be removed using <a href="#Bookmark733"><b>RemoveSyntheticSymbol</b></a>. Reloading the symbols for the module deletes all synthetic symbols associated with that module.</p>
<h3><a id="symbol_path"></a><a id="SYMBOL_PATH"></a>Symbol Path</h3>
<p>To add a directory or symbol server to the symbol path, use the method <a href="#Bookmark628"><b>AppendSymbolPath</b></a>.  The whole symbol path is returned by <a href="#Bookmark654"><b>GetSymbolPath</b></a> and can be changed using <a href="#Bookmark670"><b>SetSymbolPath</b></a>.</p></div></div>	
	<div id="winchm_template_footer">Copyright &copy; 2019. All rights 
reserved. (To change the copyright info, just edit it in template.)</div>
</div>

</body>
</html>
